@types/node-fetch

What is @types/node-fetch?

The @types/node-fetch npm package provides TypeScript type definitions for the node-fetch library, which is a light-weight module that enables making HTTP requests in Node.js environments similar to the Fetch API provided in the browser. This package does not contain functionality by itself but offers type support for using node-fetch in TypeScript projects, ensuring type safety and IntelliSense in IDEs.

What are @types/node-fetch's main functionalities?

Making HTTP GET Requests

This code demonstrates how to make a simple HTTP GET request to retrieve data from a JSON placeholder API and log it to the console. The @types/node-fetch package provides type definitions for the response object and its methods.

import fetch from 'node-fetch';

async function getTodo() {
  const response = await fetch('https://jsonplaceholder.typicode.com/todos/1');
  const data = await response.json();
  console.log(data);
}

getTodo();

Making HTTP POST Requests

This example shows how to make an HTTP POST request to create a new resource on a JSON placeholder API. It demonstrates setting the request method, body, and headers. The @types/node-fetch package ensures that the properties and methods used are correctly typed.

import fetch from 'node-fetch';

async function createTodo() {
  const response = await fetch('https://jsonplaceholder.typicode.com/todos', {
    method: 'POST',
    body: JSON.stringify({
      title: 'foo',
      body: 'bar',
      userId: 1
    }),
    headers: { 'Content-Type': 'application/json' }
  });
  const data = await response.json();
  console.log(data);
}

createTodo();

Other packages similar to @types/node-fetch

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides an easy-to-use API for making HTTP requests and has built-in support for request and response interceptors, transforming request and response data, and automatic JSON data transformation. Unlike @types/node-fetch, Axios does not require an additional types package for TypeScript support as it includes its own type definitions.

got

Got is a human-friendly and powerful HTTP request library for Node.js. It supports retries, streams, and pagination, among other features. Got is designed to be more comprehensive than node-fetch, offering more built-in functionalities like caching and request retries. TypeScript types are included in the package, so there's no need for an additional @types package.

superagent

Superagent is a light-weight progressive ajax API crafted for flexibility, readability, and a low learning curve after being frustrated with many of the existing request APIs. It works with both Node.js and browser environments. Like Axios, it has built-in type definitions, eliminating the need for a separate types package.

README

Installation

npm install --save @types/node-fetch

Summary

This package contains type definitions for node-fetch (https://github.com/bitinn/node-fetch).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-fetch.

Additional Details

• Last updated: Tue, 16 Jan 2024 23:07:00 GMT
• Dependencies: @types/node, form-data

Credits

These definitions were written by Torsten Werner, Niklas Lindgren, Vinay Bedre, Antonio Román, Andrew Leedham, Jason Li, Steve Faulkner, ExE Boss, Alex Savin, Alexis Tyler, Jakub Kisielewski, and David Glasser.